New+ Support for variables in template filenames (35287) #37074
+591
−97
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-template-filename
…upport-for-variables-in-templates
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
…upport-for-variables-in-templates
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
This comment has been minimized.
This comment has been minimized.
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
…upport-for-variables-in-templates
…ables-in-templates
crutkas
added
the
Needs-Review
|
Has conflicts |
…upport-for-variables-in-templates
Recent conflicts with GPO settings are now resolved again |
…https://github.com/cgaarden/PowerToys into New+feature-35287-support-for-variables-in-templates
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
| @@ -289,7 +297,6 @@ If you don't configure this policy, the user takes control over the setting and | |||
| <string id="MwbPolicyDefinedIpMappingRules">Predefined IP Address mapping rules</string> | |||
| <string id="NewPlusHideTemplateFilenameExtension">Hide template filename extension</string> | |||
| <string id="AllowDiagnosticData">Allow sending diagnostic data</string> | |||
| <string id="ConfigureRunAtStartup">Configure the run at startup setting</string> | |||
There was a problem hiding this comment.
Why is this string removed? I suspect a bad merge.
| @@ -18,6 +18,7 @@ public NewPlusProperties() | |||
| HideFileExtension = new BoolProperty(true); | |||
| HideStartingDigits = new BoolProperty(true); | |||
| TemplateLocation = new StringProperty(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Microsoft", "PowerToys", "NewPlus", "Templates")); | |||
| ReplaceVariables = new BoolProperty(true); | |||
There was a problem hiding this comment.
Perhaps default should be false? Since this new feature might break existing behavior in an unexpected way for some users right after updating PowerToys.
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
jaimecbernardo
approved these changes
Feb 25, 2025
There was a problem hiding this comment.
Hi @cgaarden , Thank you for opening the PR.
I think the code looks good and I like the approach. I tried to use the docs and not everything worked for me:
"$YYYY-$MM-%DD, $hh $mm $ss - $PARENT_FOLDER_NAME by %USERNAME%"
I tried this and saw that there's a error in %DD instead of $DD , but still couldn't get $PARENT_FOLDER_NAME to work for me.
I left some smaller comments a bit before writing this review. Thank you :)
jaimecbernardo
requested changes
Feb 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the Pull Request
Added support for variables in template filenames
Variables supported includes
$YYYY,$YY,$MM,$DD, - using the same syntax and implementation as in PowerRename$PARENT_FOLDER_NAME- will replace variable with the name of the parent folder%environment-variable%- will replace variable with the value of the corresponding environment variableExample:
Template filename:
$YYYY-$MM-%DD, $hh - $PARENT_FOLDER_NAME by %USERNAME%Filename on create becomes:
2025-01-25, 02 - PowerShell project by cgaardenPR Checklist
PowerToys New+ variable support in template filenames -- documentation related updates MicrosoftDocs/windows-dev-docs#5285
Detailed Description of the Pull Request / Additional comments
SHFileOperation API related
Still using SHFileOperation API - may change this in a future PR as the current implementation requires iterating through files multiple times (not really that impactful unless a template folder contains 100s+ of files/subfolders
Fixed an issue on ARM64 when depending on SHFileOperation to provide filename remapping
Minor refactoring
To help with support the variable support
Minor exception handling logic
To help get information on where New+ menu isn't being displayed
Validation Steps Performed
Example template folder + corresponding context menu
Example of project including subitems
New+ settings
(debug)
New+ related GPO policies